/*
 * Proja - project management software
 * Copyright (C) 2012  Oleg Kasian
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
package org.proja.core.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Marks controller method to be allowed
 * or not for current user.
 * @author Oleg Kasian
 * @version 1.0.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(value = ElementType.METHOD)
public @interface Allow {

    AllowUserState[] value() default AllowUserState.ANONYMOUS;

    String[] userRoles() default "";

    String[] memberRoles() default "";

    /**
     * User states that are allowed to see
     * the page. Levels are ladder, all higher levels
     * will be allowed lower rules too.
     */
    public enum AllowUserState {

        /**
         * Not authenticated user.
         */
        ANONYMOUS,

        /**
         * Authenticated, but not a member.
         */
        GUEST,

        /**
         * Authenticated and a member.
         */
        MEMBER;
    }
}
